home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / showfr10.zip / README.DOC < prev    next >
Text File  |  1992-01-11  |  11KB  |  229 lines
  1.                    System Availability Analysis - SHOWFREE
  2.                    ---------------------------------------
  3.  
  4. Copyright 1992 Clark Development Company, Inc.
  5.  
  6.  
  7. Description
  8. ===========
  9. The program contained herein, called SHOWFREE, is unlike many of the ordinary
  10. system usage analsys programs available for PCBoard BBS's.  Instead of trying
  11. to analyze HOW MUCH your system is used (which is something that is important
  12. for the sysop to know) it focuses instead on HOW FREE your system is (which is
  13. something a potential caller would want to know).
  14.  
  15. Here is an example of the difference in thinking behind the two different
  16. system analysis schemes:
  17.  
  18.   Given the following:       3 nodes running in rotary on a single phone line
  19.                              Node #1 is busy for an entire hour
  20.                              Node #2 is busy for 30 minutes of this hour
  21.                              Node #3 never gets a call this hour
  22.  
  23.   How much system is used:   Utilization is 90 minutes spread across 3 nodes.
  24.                              Some analysis programs will show this as being
  25.                              50% utilization because there were 180 system
  26.                              minutes available but only 90 were used.
  27.  
  28.   How free is the system:    The system is 100 percent free!!!  Because there
  29.                              were NO calls that rolled down to node 3 (from
  30.                              nodes 1 and 2) there was NEVER a time that a
  31.                              caller would have received a busy signal.  To
  32.                              the caller - the system was 100% free that hour.
  33.  
  34. So while the system usage analysis showed 50% usage, something the sysop needs
  35. to consider when trying to decide if his system is being properly utilized,
  36. the system availability analysis instead showed that the system was 100%
  37. available.
  38.  
  39. Here again, this data can be important to the sysop.  If the system
  40. availability drops below 50% then the sysop should realize that half the time
  41. the system is up the callers are getting BUSY SIGNALS and a new phone line may
  42. be needed.
  43.  
  44. Let's do one more example just to make sure we understand the difference:
  45.  
  46.   Given the following:       3 nodes running in rotary on a single phone line
  47.                              Node #1 is busy from 1:00 to 1:50
  48.                              Node #2 is busy from 1:20 to 1:45
  49.                              Node #3 is busy from 1:15 to 2:00
  50.  
  51.   How much system is used:   Utilization is 120 minutes spread across 3 nodes.
  52.                              Some analysis programs will show this as being
  53.                              67% utilization because there were 180 system
  54.                              minutes available and 120 of them were used.
  55.  
  56.   How free is the system:    The system has 20 minutes, from 1:00 to 1:20,
  57.                              when there is at least one node free.  Then from
  58.                              1:45 to 2:00 there are another 15 minutes free.
  59.                              All told, there were 35 minutes out of the hour
  60.                              when a caller could have connected without a
  61.                              busy signal.  That makes the system availability
  62.                              58 percent for that hour.
  63.  
  64. Program Requirements
  65. ====================
  66. This program will ONLY work properly given the following requirements:
  67.  
  68.    - A given CALLER log contains at most 24 hours worth of entries
  69.    - If an event is identified to the system it is assumed that all nodes
  70.      in a group will be down for the same period of time for the event
  71.    - Multiple nodes on a single rotary or ring-down are grouped together
  72.  
  73. This program saves a history of system availability and averages everything
  74. together.  Therefore it does not need to have more than one day's worth of
  75. information in the CALLER log and in fact putting more than one day's worth
  76. of information into the file can cause errors in the calculations.
  77.  
  78. It is therefore recommended that you delete your CALLER logs once a day.  If
  79. you have other software that needs to use more than one day's worth of
  80. information then you can append each day's log to the master log like this:
  81.  
  82.          COPY \KEEP\CALLER1 + CALLER1 \KEEP\CALLER1
  83.  
  84. The above line would add CALLER1 onto the end of \KEEP\CALLER1.
  85.  
  86.  
  87. Line Groups
  88. ===========
  89. This program will work fine on a single node system.  However, the analysis
  90. of system availability is easily predictable as the reciprocal of a system
  91. usage analysis.  In other words, if the system is 25% used then it is 75%
  92. free.
  93.  
  94. Where this program really shines is when determining the system availability
  95. across multiple nodes in a single line group.  By that, I mean, if you have
  96. had Ma Bell set you up with 5 phone lines and 3 of them ring in rotary for
  97. a set of HST modems, for example, and the other two ring in rotary for a set
  98. of Hayes V-Series modems - then you have a very obvious separation of two
  99. line groups.  One for HSTs and another for V-Series.
  100.  
  101. To make this easier...  if a caller can dial ONE PHONE NUMBER and reach more
  102. than one node - then all of the nodes that he can reach are in the same group.
  103.  
  104.  
  105. Program Installation and Usage
  106. ==============================
  107. This program is pretty easy to install.  Just make a \PCB\SHOW directory in
  108. which to run the program in (any unique subdirectory will do).  Copy all of
  109. the files into that directory.  Your EVENT.SYS file will then contain a
  110. line such as this:
  111.  
  112.       showfree showfree.cnf
  113.  
  114. The above line will create a file which you can then use as a bulletin on your
  115. system.  The format of the SHOWFREE.CNF is as follows:
  116.  
  117. ------------------------------------------------------------------------------
  118. C:\PCB\MAIN\CALLER                          # name/loc of caller logs
  119. 1-4 7-9 11                                  # node numbers to process
  120. SHOWFREE.RPT                                # name of report file
  121. SHOWFREE.SAV                                # name of average history file
  122. 02:00-02:30                                 # event start thru event end times
  123. # everything below this line is a "header" for the report file
  124. @CLS@@X0FPHONE: 801-261-8977  (nodes 1, 2, 3, 4, 7, 8, 9, 11)
  125. @X0B
  126.                            System Availability Graph
  127.                    (chances of getting through on first call)
  128. ------------------------------------------------------------------------------
  129.  
  130. The first 2 lines of the above identify where the caller logs are to be found
  131. and which node numbers to put into a group.  You can list each node number
  132. separately as in "1 2 3 4 5" or you can use a dash as in "1-5" to mean the
  133. same thing.  Spaces must be used as number separators.  Commas cannot be used.
  134.  
  135. The next line defines the name of the report file (or bulletin if you want to
  136. have the file immediately posted as a bulletin).
  137.  
  138. The next line defines the name of the history file to be used.  If you are
  139. using multiple groups then it is recommended that each group have its own
  140. history file.
  141.  
  142. The next line defines the time of the event.  It is not necessary to list an
  143. event and in fact the line can be left blank.  If an event is specified it is
  144. assumed that all nodes within the group will be down for the period of time
  145. shown for the event.
  146.  
  147. The seventh and all subsequent lines are the report header.  You can put
  148. anything you want and make the rest of the file as long or as wide as you
  149. wish.  The only rule is:  make it readable for your callers.
  150.  
  151.  
  152. Analysis Reports
  153. ================
  154. The output files created by SHOWFREE make extensive use of PCBoard v14.5's
  155. color @X codes.  This means that a single file can be viewed by graphics
  156. and non-graphics callers alike.  Of course, the graphics callers will find
  157. the file much more readable due to the advantage of color "cues" in reading
  158. the graph.
  159.  
  160.  
  161. Event Times
  162. ===========
  163. Let me give an example in the way of explanation for the need for entering
  164. your event time into the configuration file:
  165.  
  166.     fact 1:  system event starts at 2:00am
  167.     fact 2:  system event ends at 2:30am
  168.     fact 3:  all caller logs are deleted during the event
  169.  
  170. Given the above information you will be missing information in the caller logs
  171. that would give the SHOWFREE program knowledge that the system was unavailable
  172. from 2:00am until 2:30am.  The system availability analysis would, therefore,
  173. incorrectly show the time from 2:00-2:30 as being AVAILABLE when in fact it
  174. is not.
  175.  
  176. If you run multiple events you most likely do NOT delete the callers logs in
  177. each one.  Therefore there is no need to list each event.  Just the event that
  178. deletes any trace of itself by deleting the caller logs needs to be shown.
  179.  
  180.  
  181. Advanced Ideas
  182. ==============
  183. One phone line can actually participate in more than one line group.  For
  184. example, the Salt Air BBS has only two really distinct groups.  They are:
  185.  
  186.          801-261-8976   HST modems   - nodes 1, 2, 3, 7, 8, 9
  187.          801-261-8979   Hayes modems - nodes 5, 6
  188.  
  189. However, we have two phone lines that are private and cost more to access.  We
  190. call them our Extended Support lines.  These two lines participate in the same
  191. ring down used by the HST modems making the following true:
  192.  
  193.          801-261-8977   Extended Support - nodes 1, 2, 3, 4, 7, 8, 9, 11
  194.  
  195. Because two additional nodes are in the group the system availability for this
  196. particular group is higher than the system availability of the HST group.
  197. That is because with more lines to dial into there is a greater chance that
  198. one of them will be free and waiting for a phone call.
  199.  
  200. The Salt Air system, therefore, runs the SHOWFREE program three separate
  201. times like this:
  202.  
  203.    showfree hstnodes.cnf
  204.    showfree private.cnf
  205.    showfree node56.cnf
  206.    copy hstnodes.rpt+node56.rpt+private.rpt \pcb\gen\blt15
  207.  
  208. The last line, of course, copies the three separate reports into one single
  209. bulletin called blt15 which is our bulletin #15 which shows system
  210. availability charts for Salt Air.
  211.  
  212.  
  213. Have fun!
  214. =========
  215. Well, the documentation sure ended up being long for such a simple program.
  216. The output files created by SHOWFREE are fairly colorful and should provide
  217. useful information to your callers letting them know when the best times are
  218. to call your system.  And once it is set up it runs itself forever so you
  219. don't need to worry about it again.  So sit back and relax and have some fun.
  220.  
  221.  
  222. As is
  223. =====
  224. No waranties are given on this program.  It is provided as is.  It works on
  225. Salt Air given the configuration we use.  If your system is similar enough to
  226. fall within the requirements mentioned in this documentation then the program
  227. should work fine for you.  There are no guarantees for bug fixes (if any are
  228. needed) or updates to the software (in case of wishlist items).
  229.